home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir34 / bkup10.zip / BKUP.DOC < prev    next >
Text File  |  1994-05-18  |  17KB  |  340 lines

  1.  A DESCRIPTION OF BKUP.BTM
  2.  (May 16, 1994)
  3.  
  4.  BKUP.BTM transports files between computers. It can also be used
  5.  for quick 'maintenance of disk' (like deleting unnecessary files).
  6.  
  7.  Since version 10, BKUP no longer supports 4DOS prior to 5.x. Use
  8.  BKUP version 8 instead.
  9.  
  10.  BKUP.BTM is written in 4DOS batch language. 4DOS is a registered
  11.  trademark and copyrighted property of JP Software, Inc. For other
  12.  copyrighted programs see below, "Copyrighted programs".
  13.  
  14.  
  15.  CREATING A COMPRESSED FILE FOR NEW (UPDATED) FILES
  16.  ==================================================
  17.  BKUP.BTM creates a list of files saved on specified disk (default is
  18.  default [boot] drive) either [a] today, or [b] since a specified number of
  19.  days back, or [c] since a specified date.
  20.  
  21.  The list of files can be edited in various ways, leaving on it only those
  22.  files you wish to transport to your other computer(s).
  23.  
  24.  When the list editing is done, BKUP.BTM runs a compressor to create an
  25.  archive on specified drive (default is B:), with the specified date as a
  26.  name (for example, 3-26-93.ZIP). If such an archive already exists, it is
  27.  updated with new versions, or new files, if detected in the list. BKUP
  28.  can run 3 compressors: PKZIP, ZIP, and UC2. However, there are a few
  29.  limitations on using ZIP and UC2 for some options (see below, "Usage
  30.  Notes and Limitations").
  31.  
  32.  The files are archived with pathnames. This means that they will be
  33.  extracted on the target computer to the same subdirectories where they
  34.  were created on the source computer. By default, files are extracted to
  35.  the default (boot)  drive, unless otherwise specified. If a subdirectory does not
  36.  exist on the target computer, it is created by the extraction program
  37.  during extracting.
  38.  
  39.  The archive is marked with the description "Updated from: name", where
  40.  "name" stands for an actual "name" given to your computer (see below,
  41.  "'Names' for computers and diskettes".
  42.  
  43.  EXTRACTING THE UPDATED FILES FROM THE ARCHIVE TO THE OTHER
  44.  COMPUTER(S)
  45.  ==========================================================
  46.  To extract the archived file(s), use the -x (or /x, or x) switch.
  47.  BKUP.BTM can run 3 extractors: PKUNZIP, UNZIP, and UC2. However,
  48.  there are a few limitations on using ZIP and UC2 for some options (see
  49.  below, "Usage Notes and Limitations").
  50.  
  51.  If there is more than one archive on your diskette, BKUP lets you select
  52.  the one(s) you wish to extract. Extracted files (archives) are marked with
  53.  the description "Extracted to: name; name; ...", where "name" stands for
  54.  the actual "name" of your computer (see below, "'Names' for computers and
  55.  diskettes"). If you try to extract the archive again to the same computer,
  56.  you will be told that it was already extracted, and will be asked to
  57.  decide to either "force extract" it, delete the archive file from disk, or
  58.  quit. If you do not respond, BKUP will leave the archive intact and go on
  59.  after 3 seconds to treat the next one. If in doubt, don't hesitate to use
  60.  the "force extract" option, because all extractors will not overwrite
  61.  files on your disk unless the matching files stored in the archive are
  62.  newer.
  63.  
  64.  If the archive was extracted, but then was updated again with new versions
  65.  or files (this is normal if both updating and extraction are done the same
  66.  day, or for the same date), it will be marked with the description "Updated
  67.  from: name", to allow subsequent extractions as well as indicate the source
  68.  of the new files (i.e., the computer on which they have been created).
  69.  
  70.  The extraction utility pops up a menu of archive files, even if only
  71.  one such archive exists. If more than one archive exists, you can mark
  72.  those you wish to extract (by pressing the spacebar at the relevant
  73.  filename).
  74.  
  75.  EDITING THE LIST OF FILENAMES
  76.  (before compression)
  77.  =============================
  78.  When the list of all the relevant files is created, BKUP.BTM lets you
  79.  select one of the following options:
  80.  
  81.  (*) View (and handle) filenames on screen, one by one
  82.  (*) Use an editor to edit results (results file)
  83.  (*) View results before making any decision
  84.  (*) Go immediately to archiving (no selection)
  85.  (*) Quit (results file will remain intact)
  86.  If you choose viewing (and handling) files on screen, the following
  87.  options are then available while working:
  88.  
  89.  (*) Accept or omit a file (from the list)
  90.  (*) View a file before making a decision about it
  91.  (*) Delete a file from disk (after or before viewing)
  92.  (*) Stop selecting and begin archiving immediately
  93.  (*) View the list of selections at each step
  94.  (*) Quit (results file will remain intact)
  95.  
  96.  CONFIGURING BKUP
  97.  ================
  98.  BKUP can be configured by BKUP.INI. This file can easily be edited
  99.  with any editor. However, the primary parameters and options defined in
  100.  BKUP.INI can be overridden from the command line. Alternatively, aliases
  101.  can be used to avoid editing BKUP.INI. If BKUP.INI is missing or the user
  102.  prefers not to have it, and the user does not provide any commands on the
  103.  command line, BKUP will use its internal defaults.
  104.  
  105.  The PRIMARY defaults (for both compressing and extracting) are:
  106.  (replaceable from the command line)
  107.  
  108.  (1) Disk from which files will be compressed - default (boot) drive
  109.  (2) Drive where archive will be created      - B:
  110.  (3) Disk to which files will be extracted    - default (boot) drive
  111.  (4) Drive where archive will be looked for   - B:
  112.  (5) Compression and extraction programs:     - PKZIP and PKUNZIP
  113.  (6) Date for files to be updated:            - today
  114.  (7) Exclude files:                    -  *.zip *.bak *.tmp *.log *.uc2
  115.  
  116.  The SECONDARY defaults (for both compressing and extracting) are:
  117.  (NOT replaceable from the command line, but BKUP will request you
  118.  to make decisions for options (8)-(11) if BKUP.INI is missing, or
  119.  if they are not defined in BKUP.INI. Option 12 can be defined only
  120.  in BKUP.INI or in the BKUP.BTM file itself.)
  121.  
  122.  (8)  Checking the name of updates diskette     - yes
  123.  (9)  Name of updates diskette                  - "transmit"
  124.  (10) Name of search and extract drives         - computer's label
  125.  (11) Text editor to be used                    - t.com
  126.  (12) Colors of final message     - bright white & black on white;
  127.  
  128.  Therefore, if you just type "BKUP", this is equal to typing:
  129.  
  130.  (compressing:) BKUP c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  131.     (+ secondary defaults)
  132.     or
  133.  (extracting:)  BKUP -x c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  134.     (+ secondary defaults)
  135.  
  136.  "NAMES" FOR COMPUTERS AND DISKETTES
  137.  ===================================
  138.  BKUP is set to use the labels of your "search disk" and "extract disk"
  139.  (both of which would normally be your default [boot] drive) as "names" for
  140.  your computer. This makes it possible to know which of your computers
  141.  has/have been updated, and to which computers the archive has been
  142.  extracted (if there are more than one archive, BKUP will add all of
  143.  their names when the archive was extracted).
  144.  
  145.  You can change this default by entering a different name for your
  146.  computer at the 'compuname=' line in BKUP.INI.
  147.  
  148.  If your default (boot) drive has been given no label, BKUP will prompt you
  149.  to give your computer a temporary name for the current session. You
  150.  can make this "name" permanent by labeling your hard disk or typing
  151.  a name at the 'compuname=' line in BKUP.INI.
  152.  
  153.  BKUP can also be set to check the "name" (i.e., label) of the diskette
  154.  inserted into the "archive drive". If you prefer to always use the same
  155.  diskette for transporting files between your various computers, this
  156.  is the best solution for keeping all of the update archives on one
  157.  device. By default, the name of the update diskette is "TRANSMIT". You
  158.  can change the name at the 'updatedr=' line in BKUP.INI. Also, you may
  159.  cancel this option altogether by typing 'no' at the 'updatename=' line.
  160.  If this line is not defined, or BKUP.INI is missing, BKUP will prompt
  161.  you at the relevant moment to enter a name for the updates diskette.
  162.  If the diskette inserted into the drive is not the dedicated one,
  163.  BKUP will ask you if you wish to continue (i.e., put the archive on
  164.  the current diskette). You can of course switch diskettes while BKUP is
  165.  waiting for your answer.
  166.  
  167.  USAGE
  168.  =====
  169.  
  170.  HELP
  171.  ----
  172.  BKUP h (or ?) will display a set of HELP screens.
  173.  BKUP i will take you immediately to the first USAGE screen.
  174.  
  175.  Usage for ARCHIVING:
  176.  -------------------
  177.  
  178.   BKUP [<search_drive:> <archive_drive:>] [parameters] [options]
  179.     <search_drive:>  is the drive which should be searched for files
  180.     <archive_drive:> is the drive where the archive should be created
  181.  
  182.   Parameters are:  [ n|-sMM-DD-YY ]
  183.      'n' stands for 'number of days back from today'.  For example, 'BKUP 3'
  184.          will create a list since three days back from today's date.
  185.      's' (or /s or -s) stands for 'since', followed by date, in the
  186.          MM-DD-YY (month-day-year) format. For example: BKUP s01-29-90 will
  187.          create a list for files created since 29 January 1990.
  188.  
  189.   Options are:     [ /pkzip|/zip|/uc ] [ /x file(s) file(s) ...]
  190.          '/pkz'                select Katz's PKZIP and PKUNZIP (Default)
  191.          '/zip'                select free ZIP and UNZIP
  192.          '/uc'                 select UC2 (UltraCompressor II)
  193.          '/x file(s) ...'      list of file(s) for exclusion
  194.  
  195. Note:
  196.  If you specify only one drive, you will be asked by the program to specify
  197.  interactively both. This is necessary because the program cannot tell, when
  198.  you specify only one drive, whether it is 'target' or 'source'.
  199.  
  200.  
  201.  Usage for EXTRACTING
  202.  --------------------
  203.   BKUP -x|/x|x [<toupdate_drive:> <archive_drive:>] [options]
  204.   where
  205.       <toupdate_drive:>  is the drive to extract TO.
  206.       <archive_drive:>   is the drive to extract FROM.
  207.       If no drives specified, defaults are default (boot) drive ("to")
  208.       and B: ("from")
  209.       
  210.   Options are: [ /pkz|/zip|/uc ] [ /x file(s) file(s) ...]
  211.  
  212.       '/pkz'            select Katz's PKZIP and PKUNZIP (Default)
  213.       '/zip'            select free ZIP and UNZIP
  214.       '/uc'             select UC2 (UltraCompressor II)
  215.       '/x file(s) ...'  list of file(s) not to be extracted
  216.  
  217.  Note:
  218.  If you specify only one drive, you will be asked by the program to specify
  219.  interactively both. This is necessary because the program cannot tell, when
  220.  you specify only one drive, whether it is 'target' or 'source'.
  221.  
  222.  USAGE NOTES AND LIMITATIONS
  223.  ===========================
  224.  Excluding files
  225. ----------------
  226.  The list of files created by BKUP can include filenames which you actually
  227.  exclude from either compression or extraction. This makes sense if you
  228.  re-edit the list (this can be done by EDLIST.BTM) and use it as a take
  229.  file for other tasks (such as copying or moving). COMFILE.BTM can be
  230.  used for such tasks. (Both EDLIST and COMFILE are included in my
  231.  collection EZ-BTMxx.ZIP on Simtel20 /msdos/4dos.) Also, if you do not
  232.  wish a certain file to be extracted, although compressed in the archive,
  233.  exclude it via the /x switch (it makes no sense of course to put the
  234.  filename into a permanent list in BKUP.INI). You may wish to avoid
  235.  extraction if you are not sure about the version. Excluding the file via
  236.  the /x switch on the command line then makes it possible to extract it
  237.  manually to a different subdirectory and check it before replacing the
  238.  older version.
  239.  
  240.  Unfortunately, full exclusion options are possible only with PKZIP/PKUNZIP.
  241.  See next section for the limitations of using ZIP/UNZIP and UC2.
  242.  
  243.  You can enter exclusion files / filespecs at the 'excludes=' line in
  244.  BKUP.INI. The exclusion line will work for both compression and extraction.
  245.  You can also override this line from the command line via the /x switch
  246.  (see "Usage" above). If you exclude many files, BKUP will create an
  247.  exclusion file instead of entering the exclusions on the command line.
  248.  Since ZIP cannot take an exclusion file, and UC2 will hopefully run this
  249.  feature with script files only in future, make sure to use this feature only
  250.  if you use PKZIP/PKUNZIP (for ZIP and UC2 you will simply have to exclude
  251.  files from the results list). If you have a slow computer, you may gain
  252.  some speed by leaving the 'exclude=' line in BKUP.INI empty and refrain from
  253.  using this option altogether.
  254.  
  255.  Limitations of free ZIP and UNZIP
  256.  ---------------------------------
  257.  (a) ZIP/UNZIP unfortunately needs more memory than PKZIP/PKUNZIP. You may
  258.      have to quit your application to run BKUP with these programs.
  259.  (b) Due to the lack of certain exit codes, BKUP could not be configured to
  260.      put the right messages after completion or non-completion of certain
  261.      operations (like 'freshen', in case there are 'no new files for
  262.      updating').
  263.  (c) ZIP/UNZIP cannot have a take file (script file) for handling a list
  264.      of exclusion files (i.e., files not to be compressed or extracted).
  265.      This makes it impossible to have more than 53 characters in the
  266.      "exclusion line" (after the /x switch or in BKUP.INI). This can
  267.      partly be solved by rejecting undesired files from the updates
  268.      list.
  269.  
  270.  Limitations of UC2
  271.  ------------------
  272.  UC2 is an extremely strong compressor which is why it is hoped that
  273.  the current limitations be shortly fixed.
  274.  (a) UC2 unfortunately needs more memory than PKZIP/PKUNZIP. You may
  275.      have to quit your application to run BKUP with UC2. Theoretically,
  276.      UltraStealth can make it possible for UC to work with only 32K,
  277.      but then you must load your application beforehand with US, which
  278.      cannot be secured by BKUP. Currently BKUP exits if less then 400K
  279.      are available for UC2.
  280.  (b) Due to the lack of proper exit codes, BKUP could not be configured to
  281.      put the right messages after completion or non-completion of certain
  282.      operations (like 'freshen', in case there are 'no new files for
  283.      updating', and various errors).
  284.  (c) UC2 ignores exclusion files whether written directly on the command
  285.      line (which is the case if the line's size does not exceed 53
  286.      characters) or put into a take file (script file), when compressing or
  287.      extracting takes place via a script file (which is the way BKUP
  288.      works...).
  289.      Therefore, if you use UC2, be careful not to admit any undesired files
  290.      to the updates list when you edit the list.
  291.  
  292.  HISTORY
  293.  =======
  294.  BKUP.BTM was initiated by Ron Zweig (ron@ccsg.tau.ac.il), then edited
  295.  and augmented by Itamar Even-Zohar (itamarez@plato.tau.ac.il).
  296.  Version 7, November 1993: Fuller filename display and computer "name"
  297.  added for better information about which computer has been updated.
  298.  Version 8, January 1994: (1) A safer procedure for defining a temporary
  299.  drive added; (2) A better file selection menu replace the one-at-a-time
  300.  selection menu (thanks due to Sam Wilson; see label ":operate" for
  301.  details [in BKUP.BTM]). Version 9-10, March-May 1994: The new date range
  302.  option for DIR replaces Winer's PCTODAY for those who work with 4DOS
  303.  5.x; (2) BKUP was split into primary and auxiliary files; BKUP.INI
  304.  added to facilitate configuring; (3) Both Free ZIP/UNZIP and UC2 have been
  305.  added as alternatives to PKZIP/PKUNZIP; (4) Files can now be excluded
  306.  also from the command line (an /x switch added) for both compression and
  307.  extraction.
  308.  
  309.  Copyrighted programs
  310.  ====================
  311.  PKZIP/PKUNZIP (c) may be purchased from PKWARE, Inc., 9025 N. Deerwood Dr.,
  312.  Brown Deer, WI 53223-2437, USA. Phone: 414-354-8699; FAX: 414-354-8559;
  313.  BBS: 414-354-8670. It may also be downloaded from Simtel20 mirror sites in
  314.  /msdos/zip.
  315.  
  316.  PKZIP/PKUNZIP, can be replaced by (1) the free ZIP and UNZIP, downloadable
  317.  from Simtel20 mirror sites (in /msdos/zip), or by (2) UC2 (UltraCompressor
  318.  II), downloadable from Simtel20's /msdos/archiver.
  319.  
  320.  To run ZIP/UNZIP or UC2, you must either modify BKUP.INI, or always put
  321.  the /zip or /uc switch on the command line, or put this option into your
  322.  BKUP alias. However, ZIP/UNZIP and UC2 unfortunately have several
  323.  shortcomings. For details see "Usage Notes and Limitations").
  324.  
  325.  UC is produced by Ad Infinitum Programs, the Netherlands (AIP-NL).
  326.  Address: AIP-NL, P.O. Box 1432, 3430 BK Nieuwegein, The Netherlands.
  327.  Internet: desk@aip.nl; CompuServe: 100115,2303; Fido: 2:281/713.1.
  328.  Phone: +31-30-662107; FAX: +31-30-616571; BBS: +31-3402-55707.
  329.  
  330.  
  331.  Itamar Even-Zohar
  332.  Porter Chair of Semiotics
  333.  Tel Aviv University
  334.  Tel Aviv 69978 Israel
  335.    Phone: +972-3-6427233 (office)
  336.    Fax:   +972-3-6422141 (office)
  337.    e-mail addresses:
  338.    itamarez@plato.tau.ac.il
  339.    or itiez@ccsg.tau.ac.il
  340.